home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / lib / c / etc / RCS / Stat.man,v < prev    next >
Text File  |  1991-01-25  |  2KB  |  82 lines
  1. head     1.1;
  2. branch   ;
  3. access   ;
  4. symbols  ;
  5. locks    ; strict;
  6. comment  @@;
  7.  
  8.  
  9. 1.1
  10. date     91.01.25.17.15.51;  author kupfer;  state Exp;
  11. branches ;
  12. next     ;
  13.  
  14.  
  15. desc
  16. @Manual page for Stat_GetMsg & Stat_PrintMsg.
  17. @
  18.  
  19.  
  20.  
  21. 1.1
  22. log
  23. @Initial revision
  24. @
  25. text
  26. @'\" Copyright 1991 Regents of the University of California
  27. '\" Permission to use, copy, modify, and distribute this
  28. '\" documentation for any purpose and without fee is hereby
  29. '\" granted, provided that this notice appears in all copies.
  30. '\" The University of California makes no representations about
  31. '\" the suitability of this material for any purpose.  It is
  32. '\" provided "as is" without express or implied warranty.
  33. '\" 
  34. '\" $Header: /sprite/lib/forms/RCS/lib.man,v 1.3 91/01/07 17:55:52 mottsmth Exp $ SPRITE (Berkeley)
  35. '/" 
  36. .so \*(]ltmac.sprite
  37. .HS Stat lib
  38. .BS
  39. '\" Note:  do not modify the .SH NAME line immediately below!
  40. .SH NAME
  41. Stat_GetMsg, Stat_PrintMsg \- Text description of Sprite status codes
  42. .SH SYNOPSIS
  43. .nf
  44. \fB#include <status.h>\fR
  45. .sp
  46. char *
  47. \fBStat_GetMsg\fR(\fIstatus\fP)
  48. .sp
  49. void
  50. \fBStat_PrintMsg\fR(\fIstatus\fR, \fIstring\fR)
  51. .SH ARGUMENTS
  52. .AS ReturnStatus *string
  53. .AP ReturnStatus status in
  54. Status code to return text for.
  55. .AP char *string in
  56. Supplemental string to be printed.
  57. .BE
  58.  
  59. .SH DESCRIPTION
  60. .PP
  61. These functions provide a human-readable text string for a given
  62. Sprite status value.
  63. .B Stat_GetMsg
  64. returns a read-only string to the caller.
  65. .B Stat_PrintMsg 
  66. prints a message on the standard error stream.  The message looks like
  67. ``\fIstring\fR: \fImessage\fR'', where
  68. .I string
  69. is passed in by the caller, and
  70. .I message
  71. is obtained by calling 
  72. .BR Stat_GetMsg .
  73. The
  74. .I string
  75. may be null, in which case only the
  76. .I message
  77. is printed.
  78.  
  79. .SH KEYWORDS
  80. status
  81. @
  82.